Last updated on 26-Jun-2020 by Jakob Jakobsen Boysen

Jakob Jakobsen Boysen

Platform Lead
boysen@scifeon.com

The OData endpoints adhere to the standards defined by the OData organization in the document here:

Authenticating to the OData API is the same as for the other endpoints, as described here

Endpoints

The endpoints described below adhere to the most recent OData version (4). Version 3 is supported on the /odatav3 endpoint, but not described here.

Root

GET /odata

Response

application/json

Returns a JSON object with an URL to the metadata document, and available EntitySets. Currently only database views are returned. Scifeon entities EntitySets are planned.

Metadata

GET /odata/$metadata

Response

application/xml

Returns an XML document describing the properties of the EntityTypes used in the EntitySets.

EntitySet endpoint

GET /odata/{view}

Request

Path parameters

• view A EntitySet, i.e. a name of a database view.

Query parameters

The following query parameters are documented in detail in the OData specification:

• $top Number. Limits result count.
• $skip Number. Requests the number of results to be skipped. $top and $skip can be used in conjunction to page results, e.g. ?$skip=20&$top=10 will request 10 items after the first 20 are skipped, i.e. page 3.
• $select Strings, split by a comma. Returns only properties specified. E.g. ?$select=Prop1,Prop2.
• $orderby Strings, split by comma. Sort result by property. E.g. $orderby=Prop1,Prop2 desc sorts ascending by Prop1 and then descending by Prop2.
• $filter String, split by and. Filters the result. See supported filters here

Response

application/json

Returns a object of the following format:

{
    "@odata.context": "/odata/$metadata#{view}",
    "value": [{
        // object with properties as described by the metadata document
    }]
}

Examples